Skip to main content

NGIAB End-to-End Setup Guide

Overview​

This guide provides step-by-step instructions for setting up and running the complete NGIAB workflow, including data preprocessor, model execution, TEEHR evaluation and Tethys visualization.

info

For a slightly more in-depth tutorial, please see the NGIAB 101 module.

Prerequisites​

  • Python 3.x
  • Git
  • Docker
  • Terminal access
  • Astral UV

Video Tutorial​

Quick Start Guide (5 minutes)​

You can watch our step-by-step video guide here:

(System: Using Mac M4 Max Laptop)

Step 1: Data Preprocessing​

Run Data Preprocess tool​

# Execute preprocess for sample catchment
uvx --from ngiab_data_preprocess cli -i gage-10154200 -sfr --start 2017-09-01 --end 2018-09-01 --source aorc

Parameters Explained​

ParameterDescription
-i gage-10154200Specifies the gage ID
--subsetCreates a subset of the data
--startStart date for the analysis
--endEnd date for the analysis
--forcingsIncludes forcing data
--realizationGenerates realization data

Step 2: NGIAB Setup and Execution​

Clone and Run NGIAB​

# Return to home directory
cd ..

# Clone NGIAB repository
git clone https://github.com/CIROH-UA/NGIAB-CloudInfra.git

# Navigate to NGIAB directory
cd NGIAB-CloudInfra

# Execute the setup and run script
./guide.sh

Automated Process​

The guide.sh script automatically:

  • Sets up the NGIAB environment
  • Launches the NextGen model
  • Initializes and run TEEHR evaluation
  • Starts the Tethys visualization interface

Accessing the Tools​

After successful execution, you can access:

  • NGIAB Visualizer: http://localhost/apps/ngiab

Troubleshooting​

Common issues and solutions:

  1. Docker Issues

    • Ensure Docker is running
    • Verify Docker configuration
    • Check Docker permissions

  2. Virtual Environment

    • Confirm that the virtual environment was activated
    • Check Python version compatibility

  3. Installation Problems

    • Verify that prerequisites and system requirements are met
    • Review error logs for further information
    • If using WSL: ensure that the repository was pulled using LF line endings

Additional Resources​

Documentation​

Support​

For technical support:

  • Create an issue in the respective GitHub repository
  • Contact CIROH support team
  • Join community discussions on CIROH Slack